<html>
   <head>
      <link rel="stylesheet" type="text/css" href="style.css" />
   </head>
   <body onload="">
<h2 class="comptitle">Simple Module <i>BatteryStats</i></h2>
<b>Package:</b> org.mixim.modules.power.battery<br/><b>File: <a href="modules-power-battery-BatteryStats.ned.html">modules/power/battery/BatteryStats.ned</a></b><br/><p><a href="../doxy/a00034.html" target="mainframe"><b>C++ definition</b></a></p>

<p>module for collecting battery statistics</p>
<img src="org.mixim.modules.power.battery.BatteryStats-type.png" ismap="yes" usemap="#type-diagram"/><map name="type-diagram">
<area shape="rect" href="org.mixim.modules.power.battery.BatteryStats.html" title="BatteryStats" alt="BatteryStats" coords="0,0,125,40">
</map>
<h3 class="subtitle">Usage diagram:</h3>
<p>The following diagram shows usage relationships between types.
Unresolved types are missing from the diagram. Click <a href="full-ned-usage-diagram.html">here</a> to see the full picture.</p>
<img src="org.mixim.modules.power.battery.BatteryStats-usage.png" ismap="yes" usemap="#usage-diagram"/><map name="usage-diagram"><area shape="rect" id="node1" href="org.mixim.modules.power.battery.BatteryStats.html" title="Simple Module BatteryStats" alt="" coords="307,83,400,111">
<area shape="rect" id="node2" href="org.mixim.modules.node.Host802154_2400MHz.html" title="Compound Module Host802154_2400MHz" alt="" coords="5,6,160,34">
<area shape="rect" id="node4" href="org.mixim.modules.node.Host802154A.html" title="Compound Module Host802154A" alt="" coords="184,6,285,34">
<area shape="rect" id="node6" href="org.mixim.modules.node.HostBMAC.html" title="Compound Module HostBMAC" alt="" coords="309,6,397,34">
<area shape="rect" id="node8" href="org.mixim.modules.node.HostLMAC.html" title="Compound Module HostLMAC" alt="" coords="421,6,507,34">
<area shape="rect" id="node10" href="org.mixim.examples.ieee802154Narrow.PhyMacHost.html" title="Compound Module PhyMacHost" alt="" coords="531,6,629,34">
</map>
<h3 class="subtitle">Inheritance diagram:</h3>
<p>The following diagram shows inheritance relationships for this type.
Unresolved types are missing from the diagram. Click <a href="full-ned-inheritance-diagram.html">here</a> to see the full picture.</p>
<img src="org.mixim.modules.power.battery.BatteryStats-inheritance.png" ismap="yes" usemap="#inheritance-diagram"/><map name="inheritance-diagram"><area shape="rect" id="node1" href="org.mixim.modules.power.battery.BatteryStats.html" title="Simple Module BatteryStats" alt="" coords="5,6,99,34">
</map>
<h3 class="subtitle">Used in compound modules:</h3>
<p>If a module type shows up more than once, that means it has been defined in more than one NED file.</p>
<table>
<tr>
   <td>
      <a href="org.mixim.modules.node.Host802154_2400MHz.html">Host802154_2400MHz</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>

<p>This NED module defines a host using an IEEE 802.15.4 transceiver at 2.4GHz
for wireless communications, that can be used to simulate wireless sensor
networks. </p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.node.Host802154A.html">Host802154A</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>

<p>This host NED module models a host using an IEEE 802.15.4A correlation receiver.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.node.HostBMAC.html">HostBMAC</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>

<p>Example host module using a <a href="org.mixim.examples.bmac.BMAC.html">BMAC</a> Network interface card.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.modules.node.HostLMAC.html">HostLMAC</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>

<p>Example host module using a <a href="org.mixim.examples.lmac.LMAC.html">LMAC</a> Network interface card.</p>
   </td>
</tr>
<tr>
   <td>
      <a href="org.mixim.examples.ieee802154Narrow.PhyMacHost.html">PhyMacHost</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>
<i>(no description)</i>
   </td>
</tr>
</table>
<h3 class="subtitle">Parameters:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Default value</th>
      <th>Description</th>
   </tr>
<tr class="local">
   <td width="150">notAffectedByHostState</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120">true</td>
   <td>   </td>
</tr>
<tr class="local">
   <td width="150">debug</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>write per-activity and per-device statistics to omnetpp.sca
(if false, only total energy and lifetime are written)</p>
   </td>
</tr>
<tr class="local">
   <td width="150">detail</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>subscribe to battery status and record time series
data in omnetpp.vec (resolution depends on battery's 
publishDelta)</p>
   </td>
</tr>
<tr class="local">
   <td width="150">timeSeries</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>   </td>
</tr>
</table>
<h3 class="subtitle">Source code:</h3>
<pre class="src"><span style="color: #808080; font-style: italic; ">//
// module for collecting battery statistics
//
</span><span style="color: #800000; font-weight: bold; ">simple</span><span style="color: #000000; "> </span><span style="color: #000000; ">BatteryStats</span><span style="color: #000000; ">
{
    </span><span style="color: #800000; font-weight: bold; ">parameters</span><span style="color: #000000; ">:
        </span><span style="color: #000080; font-weight: bold; ">bool</span><span style="color: #000000; "> </span><span style="color: #000000; ">notAffectedByHostState</span><span style="color: #000000; "> = </span><span style="color: #008000; ">true</span><span style="color: #000000; ">;
        </span><span style="color: #000080; font-weight: bold; ">bool</span><span style="color: #000000; "> </span><span style="color: #000000; ">debug</span><span style="color: #000000; ">;
        </span><span style="color: #808080; font-style: italic; ">// write per-activity and per-device statistics to omnetpp.sca
</span><span style="color: #000000; ">		</span><span style="color: #808080; font-style: italic; ">// (if false, only total energy and lifetime are written)
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">bool</span><span style="color: #000000; "> </span><span style="color: #000000; ">detail</span><span style="color: #000000; ">;
        </span><span style="color: #808080; font-style: italic; ">// subscribe to battery status and record time series
</span><span style="color: #000000; ">		</span><span style="color: #808080; font-style: italic; ">// data in omnetpp.vec (resolution depends on battery's 
</span><span style="color: #000000; ">		</span><span style="color: #808080; font-style: italic; ">// publishDelta)
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">bool</span><span style="color: #000000; "> </span><span style="color: #000000; ">timeSeries</span><span style="color: #000000; ">;
}
</span></pre>
   <hr><p class="footer"><a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top"><img src="by-sa.png"></a> This documentation is released under the <a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top">Creative Commons license</a></p>
   </body>
</html>
